Interface ParameterMap

All Superinterfaces:
IPCObject
All Known Implementing Classes:
ParameterMapImpl

public interface ParameterMap extends IPCObject
Information provided by the PKI file:

    \class ParameterMap
    
    \brief ParameterMap handles and manipulates Zone-Based Policy Firewall parameter maps.
    
    \example network().getDevice("Router0").getParameterMapManager().getParameterMapAt(0)
    
Author:
Auto-generated
  • Method Details

    • getMapName

      String getMapName()
      Information provided by the PKI file:
      
          \brief Returns the name of the paramter map.
          
          \return string, the name of the paramter map.
          
              
      Returns:
      String Returns a String
    • getMapType

      ZfwMapType getMapType()
      Information provided by the PKI file:
      
          \brief Returns the type of the paramter map.
          
          \return ZfwMapType, the type of the paramter map.
          Map types:  type_default = 0,
          type_global = 1,
          type_inspect = 2,
          
              
      Returns:
      ZfwMapType Returns a ZfwMapType
    • setInUsed

      void setInUsed(boolean p_used)
      Information provided by the PKI file:
      
          \brief Sets the parameter map as in use or not in use.
          
          \param p_used, true for in use, false for not in use.
          
              
      Parameters:
      p_used - Takes in a parameter of p_used
    • setMapType

      void setMapType(ZfwMapType mapType)
      Information provided by the PKI file:
      
          \brief Sets the type of the paramter map.
          
          \param mapType,     the type of the paramter map.
          Map types:  type_default = 0,
          type_global = 1,
          type_inspect = 2,
          
              
      Parameters:
      mapType - Takes in a parameter of mapType
    • setAlert

      void setAlert(boolean p_on_off)
      Information provided by the PKI file:
      
          \brief Turns on or off alert.
          
          \param p_on_off, true to enable alert, false to disable it.
          
              
      Parameters:
      p_on_off - Takes in a parameter of p_on_off
    • setAlertEnable

      void setAlertEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables alert.
          
          \param p_enable, true to enable alert, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setAuditTrail

      void setAuditTrail(boolean p_on_off)
      Information provided by the PKI file:
      
          \brief Turns on or off audit-trail.
          
          \param p_on_off, true to enable audit-trail, false to disable it.
          
              
      Parameters:
      p_on_off - Takes in a parameter of p_on_off
    • setAuditTrailEnable

      void setAuditTrailEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables audit-trail.
          
          \param p_enable, true to enable audit-trail, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setDnsTimeout

      void setDnsTimeout(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the dns-timeout value.
          
          \param p_time, the dns-timeout value.
          
              
      Parameters:
      p_time - Takes in a parameter of p_time
    • setDnsTimeoutEnable

      void setDnsTimeoutEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables dns-timeout.
          
          \param p_enable, true to enable dns-timeout, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setIcmpIdleTimeout

      void setIcmpIdleTimeout(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the icmp idle-timeout value.
          
          \param p_time, the icmp idle-timeout value.
          
              
      Parameters:
      p_time - Takes in a parameter of p_time
    • setIcmpIdleTimeoutEnable

      void setIcmpIdleTimeoutEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables icmp idle-timeout.
          
          \param p_enable, true to enable icmp idle-timeout, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setMaxIncompleteLow

      void setMaxIncompleteLow(int p_num)
      Information provided by the PKI file:
      
          \brief Sets the max-incomplete low value.
          
          \param p_num, the max-incomplete low value.
          
              
      Parameters:
      p_num - Takes in a parameter of p_num
    • setMaxIncompleteLowEnable

      void setMaxIncompleteLowEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables max-incomplete low.
          
          \param p_enable, true to enable max-incomplete low, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setMaxIncompleteHigh

      void setMaxIncompleteHigh(int p_num)
      Information provided by the PKI file:
      
          \brief Sets the max-incomplete high value.
          
          \param p_num, the max-incomplete high value.
          
              
      Parameters:
      p_num - Takes in a parameter of p_num
    • setMaxIncompleteHighEnable

      void setMaxIncompleteHighEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables max-incomplete high.
          
          \param p_enable, true to enable max-incomplete high, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setSessionMax

      void setSessionMax(int p_num)
      Information provided by the PKI file:
      
          \brief Sets the session max value.
          
          \param p_num, the session max value.
          
              
      Parameters:
      p_num - Takes in a parameter of p_num
    • setSessionMaxEnable

      void setSessionMaxEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables session max.
          
          \param p_enable, true to enable session max, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setOneMinLow

      void setOneMinLow(int p_num)
      Information provided by the PKI file:
      
          \brief Sets the one-minute low value.
          
          \param p_num, the one-minute low value.
          
              
      Parameters:
      p_num - Takes in a parameter of p_num
    • setOneMinLowEnable

      void setOneMinLowEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables one-minute low.
          
          \param p_enable, true to enable one-minute low, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setOneMinHigh

      void setOneMinHigh(int p_num)
      Information provided by the PKI file:
      
          \brief Sets the one-minute high value.
          
          \param p_num, the one-minute high value.
          
              
      Parameters:
      p_num - Takes in a parameter of p_num
    • setOneMinHighEnable

      void setOneMinHighEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables one-minute high.
          
          \param p_enable, true to enable one-minute high, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setTcpFinWaitTimeout

      void setTcpFinWaitTimeout(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the tcp finwait-time value.
          
          \param p_time, the tcp finwait-time value.
          
              
      Parameters:
      p_time - Takes in a parameter of p_time
    • setTcpFinWaitTimeoutEnable

      void setTcpFinWaitTimeoutEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables tcp finwait-time.
          
          \param p_enable, true to enable tcp finwait-time, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setTcpIdleTimeout

      void setTcpIdleTimeout(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the tcp idle-time value.
          
          \param p_time, the tcp idle-time value.
          
              
      Parameters:
      p_time - Takes in a parameter of p_time
    • setTcpIdleTimeoutEnable

      void setTcpIdleTimeoutEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables tcp idle-time.
          
          \param p_enable, true to enable tcp idle-time, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setTcpMaxIncompleteConn

      void setTcpMaxIncompleteConn(int p_num)
      Information provided by the PKI file:
      
          \brief Sets the tcp max-incomplete host value.
          
          \param p_num, the tcp max-incomplete host value.
          
              
      Parameters:
      p_num - Takes in a parameter of p_num
    • setTcpMaxIncompleteConnEnable

      void setTcpMaxIncompleteConnEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables tcp max-incomplete host.
          
          \param p_enable, true to enable tcp max-incomplete host, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setTcpMaxIncompleteConnBlockTime

      void setTcpMaxIncompleteConnBlockTime(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the tcp max-incomplete host block-time value.
          
          \param p_time, the tcp max-incomplete host block-time value.
          
              
      Parameters:
      p_time - Takes in a parameter of p_time
    • setTcpMaxIncompleteConnBlockTimeEnable

      void setTcpMaxIncompleteConnBlockTimeEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables tcp max-incomplete host block-time.
          
          \param p_enable, true to enable tcp max-incomplete host block-time, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setTcpSynWaitTimeout

      void setTcpSynWaitTimeout(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the tcp synwait-time value.
          
          \param p_time, the tcp synwait-time value.
          
              
      Parameters:
      p_time - Takes in a parameter of p_time
    • setTcpSynWaitTimeoutEnable

      void setTcpSynWaitTimeoutEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables tcp synwait-time block-time.
          
          \param p_enable, true to enable tcp synwait-time, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setUdpIdleTimeout

      void setUdpIdleTimeout(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the udp idle-time value.
          
          \param p_time, the udp idle-time value.
          
              
      Parameters:
      p_time - Takes in a parameter of p_time
    • setUdpIdleTimeoutEnable

      void setUdpIdleTimeoutEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables udp idle-time.
          
          \param p_enable, true to enable udp idle-time, false to disable it.
          
              
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • getAlert

      boolean getAlert()
      Information provided by the PKI file:
      
          \brief Returns true if alert is on, otherwise false.
          
          \return bool, true if alert is on, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getAlertEnable

      boolean getAlertEnable()
      Information provided by the PKI file:
      
          \brief Returns true if alert is enabled, otherwise false.
          
          \return bool, true if alert is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getAuditTrail

      boolean getAuditTrail()
      Information provided by the PKI file:
      
          \brief Returns true if audit-trail is on, otherwise false.
          
          \return bool, true if audit-trail is on, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getAuditTrailEnable

      boolean getAuditTrailEnable()
      Information provided by the PKI file:
      
          \brief Returns true if audit-trail is enabled, otherwise false.
          
          \return bool, true if audit-trail is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getDnsTimeout

      int getDnsTimeout()
      Information provided by the PKI file:
      
          \brief Returns the dns-timeout value.
          
          \return int, the dns-timeout value.
          
              
      Returns:
      int Returns a int
    • getDnsTimeoutEnable

      boolean getDnsTimeoutEnable()
      Information provided by the PKI file:
      
          \brief Returns true if dns-timeout is enabled, otherwise false.
          
          \return bool, true if dns-timeout is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getIcmpIdleTimeout

      int getIcmpIdleTimeout()
      Information provided by the PKI file:
      
          \brief Returns the icmp idle-timeout value.
          
          \return int, the icmp idle-timeout value.
          
              
      Returns:
      int Returns a int
    • getIcmpIdleTimeoutEnable

      boolean getIcmpIdleTimeoutEnable()
      Information provided by the PKI file:
      
          \brief Returns true if icmp idle-timeout is enabled, otherwise false.
          
          \return bool, true if icmp idle-timeout is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getMaxIncompleteLow

      int getMaxIncompleteLow()
      Information provided by the PKI file:
      
          \brief Returns the max-incomplete low value.
          
          \return int, the max-incomplete low value.
          
              
      Returns:
      int Returns a int
    • getMaxIncompleteLowEnable

      boolean getMaxIncompleteLowEnable()
      Information provided by the PKI file:
      
          \brief Returns true if max-incomplete low is enabled, otherwise false.
          
          \return bool, true if max-incomplete low is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getMaxIncompleteHigh

      int getMaxIncompleteHigh()
      Information provided by the PKI file:
      
          \brief Returns the max-incomplete high value.
          
          \return int, the max-incomplete high value.
          
              
      Returns:
      int Returns a int
    • getMaxIncompleteHighEnable

      boolean getMaxIncompleteHighEnable()
      Information provided by the PKI file:
      
          \brief Returns true if max-incomplete high is enabled, otherwise false.
          
          \return bool, true if max-incomplete high is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getSessionMax

      int getSessionMax()
      Information provided by the PKI file:
      
          \brief Returns the session max value.
          
          \return int, the session max value.
          
              
      Returns:
      int Returns a int
    • getSessionMaxEnable

      boolean getSessionMaxEnable()
      Information provided by the PKI file:
      
          \brief Returns true if session max is enabled, otherwise false.
          
          \return bool, true if session max is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getOneMinLow

      int getOneMinLow()
      Information provided by the PKI file:
      
          \brief Returns the one-minute low value.
          
          \return int, the one-minute low value.
          
              
      Returns:
      int Returns a int
    • getOneMinLowEnable

      boolean getOneMinLowEnable()
      Information provided by the PKI file:
      
          \brief Returns true if one-minute low is enabled, otherwise false.
          
          \return bool, true if one-minute low is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getOneMinHigh

      int getOneMinHigh()
      Information provided by the PKI file:
      
          \brief Returns the one-minute high value.
          
          \return int, the one-minute high value.
          
              
      Returns:
      int Returns a int
    • getOneMinHighEnable

      boolean getOneMinHighEnable()
      Information provided by the PKI file:
      
          \brief Returns true if one-minute high is enabled, otherwise false.
          
          \return bool, true if one-minute high is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getTcpFinWaitTimeout

      int getTcpFinWaitTimeout()
      Information provided by the PKI file:
      
          \brief Returns the tcp finwait-time value.
          
          \return int, the tcp finwait-time value.
          
              
      Returns:
      int Returns a int
    • getTcpFinWaitTimeoutEnable

      boolean getTcpFinWaitTimeoutEnable()
      Information provided by the PKI file:
      
          \brief Returns true if tcp finwait-time is enabled, otherwise false.
          
          \return bool, true if tcp finwait-time is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getTcpIdleTimeout

      int getTcpIdleTimeout()
      Information provided by the PKI file:
      
          \brief Returns the tcp idle-time value.
          
          \return int, the tcp idle-time value.
          
              
      Returns:
      int Returns a int
    • getTcpIdleTimeoutEnable

      boolean getTcpIdleTimeoutEnable()
      Information provided by the PKI file:
      
          \brief Returns true if tcp idle-time is enabled, otherwise false.
          
          \return bool, true if tcp idle-time is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getTcpMaxIncompleteConn

      int getTcpMaxIncompleteConn()
      Information provided by the PKI file:
      
          \brief Returns the tcp max-incomplete host value.
          
          \return int, the tcp max-incomplete host value.
          
              
      Returns:
      int Returns a int
    • getTcpMaxIncompleteConnEnable

      boolean getTcpMaxIncompleteConnEnable()
      Information provided by the PKI file:
      
          \brief Returns true if tcp max-incomplete host is enabled, otherwise false.
          
          \return bool, true if tcp max-incomplete host is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getTcpMaxIncompleteConnBlockTime

      int getTcpMaxIncompleteConnBlockTime()
      Information provided by the PKI file:
      
          \brief Returns the tcp max-incomplete host block-time value.
          
          \return int, the tcp max-incomplete host block-time value.
          
              
      Returns:
      int Returns a int
    • getTcpMaxIncompleteConnBlockTimeEnable

      boolean getTcpMaxIncompleteConnBlockTimeEnable()
      Information provided by the PKI file:
      
          \brief Returns true if tcp max-incomplete host block-time is enabled, otherwise false.
          
          \return bool, true if tcp max-incomplete host block-time is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getTcpSynWaitTimeout

      int getTcpSynWaitTimeout()
      Information provided by the PKI file:
      
          \brief Returns the tcp synwait-time value.
          
          \return int, the tcp synwait-time value.
          
              
      Returns:
      int Returns a int
    • getTcpSynWaitTimeoutEnable

      boolean getTcpSynWaitTimeoutEnable()
      Information provided by the PKI file:
      
          \brief Returns true if tcp synwait-time is enabled, otherwise false.
          
          \return bool, true if tcp synwait-time is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getUdpIdleTimeout

      int getUdpIdleTimeout()
      Information provided by the PKI file:
      
          \brief Returns the udp idle-time value.
          
          \return int, the tcp idle-time value.
          
              
      Returns:
      int Returns a int
    • getUdpIdleTimeoutEnable

      boolean getUdpIdleTimeoutEnable()
      Information provided by the PKI file:
      
          \brief Returns true if udp idle-time is enabled, otherwise false.
          
          \return bool, true if udp idle-time is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isInUsed

      boolean isInUsed()
      Information provided by the PKI file:
      
          \brief Returns true if the parameter map is in use, otherwise false.
          
          \return bool, true if the parameter map is in use, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • toString

      String toString()
      Information provided by the PKI file:
      
          \brief Returns the name of the parameter map.
          
          \return string, the name of the parameter map.
          
              
      Overrides:
      toString in class Object
      Returns:
      String Returns a String